-
Notifications
You must be signed in to change notification settings - Fork 75
jQuery.effects.define() #288
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
I added |
Looks good :-) (i.e. no typo) |
I added |
I added |
All looks good :-) |
</signature> | ||
<desc>Saves all inline styles applied to an element.</desc> | ||
<longdesc> | ||
<p>Saves all inline styles applied to an element. This is useful when animating various styles and restoring the existing styles at the end. The saved styles can be restored using <a href="/jQuery.effects.restoreStyle/"><code>jQuery.effects.restoreStyle()</code></a>.</p> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This needs to explain what "save" means here. As far as I can tell it stores a copy of style.cssText
via .data()
, without making any changes to the styles itself.
Also applies to restoreStyle
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The how is pure internal details. The only thing the user should care about is how to restore the styles that have been saved, which is documented.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Its not just internal details. The semantics of the method were unclear to me until I read the code, which makes for bad documentation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you explain what semantics were unclear?
Apart from the underspecified |
Updated the wording for |
Looks good |
Merged into 1-12. |
No description provided.